home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / AMICUS / AMICUS09.ADF / Progs / Wombat.DOC < prev    next >
Text File  |  1986-05-22  |  12KB  |  303 lines
  1. the Wombat Terminal Program (version 1)        Preliminary docs 02-feb-86
  2. Copyright (C) 1986 by Dave warker
  3.  
  4.  
  5. --- HELLO THERE!
  6.  
  7.      This is a quicky information file which explains, though briefly,
  8. the features of the Wombat Terminal Program (Wtp).  The next version of
  9. Wtp will (hopefully) feature a more extensive documentation file.
  10.  
  11. Some of the features of Wtp which may be of interest:
  12.  
  13.  - full 80 x 24 screen. A 25th display line is reserved for statuc info.
  14.  
  15.  - limited ANSI control sequence recognition. Supports enough to allow
  16.    use with VT-100 terminal option on Delphi and Compuserve. Next version
  17.    will support many more of the VT-100 functions.
  18.  
  19.  - Text file data capture and transmission. Options are provided to auto-
  20.    magically convert CR/LFs to LF on receive and LFs to CR/LF on transmit.
  21.    Another options allows stripping of all control characters except CR, LF
  22.    and TABs from incoming and outgoing text files.
  23.  
  24.  - XMODEM file transfer both text and binary files.  The options provided
  25.    for text file capture and transmission also apply for XMODEM text file
  26.    transfers.
  27.  
  28.  - Phone dialing functions.
  29.  
  30.  - Load and save of current parameter settings. Optionally will auto-dial
  31.    when a new set of parameters are loaded.
  32.  
  33.  - Use of speech as an alternate terminal bell.
  34.  
  35.  - other stuff.
  36.  
  37.  
  38. --- STUFF:
  39.      Note that the correct file size for Wtp version 1 is 29244 bytes.
  40.  
  41.  
  42. --- STARTING UP 'WTP'.
  43.  
  44.      Wtp must (currently) be started from the CLI. I will support the
  45. Workbench as soon as I get ambitious enough to design an Icon for it.
  46. (Drawing a Wombat is hard when you have no artistic ability.)
  47.      There is a single optional argument which should be the name of a
  48. Wtp settings file created with the "Save settings" menu selection.  If
  49. supplied then those settings will be in effect when Wtp starts up.
  50.      If no arguments are supplied then Wtp looks for a default settings
  51. file named "default.wtp", first in the current directory, then in the
  52. directory "SYS:wtp/".  The first file found is used.
  53.      If no default settings file is found Wtp will use a resonable set
  54. of default values, resaonable for me that is.  If you don't like them
  55. you should change the settings to match your preferences then save them
  56. as "default.wtp" someplace.
  57.  
  58.      When Wtp finishes loading you will see a blank screen with a cursor
  59. in the upper left corner.  If instead you wind up back in the CLI then
  60. Wtp could not start up for some reason, not ewnough memory or no serial
  61. driver, etc.  Unfortunately the current version does not display a message
  62. as to the reason for the failure. The next version will.
  63.      At this point you are up and running and should peruse the menu
  64. options to inspect/change the settings as needed.
  65.  
  66.  
  67. --- LEAVING 'WTP'.
  68.  
  69.      Just select 'quit' from the 'Stuff' menu. All system resources will
  70. be returned to the OS and any open transfer files will be closed.
  71.  
  72.  
  73. --- ANSI CONTROL SEQUENCES SUPPORTED:
  74.  
  75. The following control characters are supported:
  76.  
  77. HEX    NAME    FUNCTION
  78.  
  79.  0D     CR     Carriage return, moves cursor to column 1 of current line.
  80.  0A     LF     Line feed. Moves cursor to same column of next line.
  81.  08     BS     Backspace, move cursor left one character.
  82.  07     BEL     Bell. What happens depends on current bell selection.
  83.  09     HT     Horizontal TAB. Moves cursor to next multiple of 8 column.
  84.  1B     ESC     Introduces ANSI CSI and DCS sequences defined below.
  85.  0B     VT     Vertical TAB, treated same as LF.
  86.  0C     FF     Form feed, treated same as LF.
  87.  
  88. All other control characters, including rubouts (7F hex) are ignored for
  89. display on screen.
  90.  
  91. The following ANSI sequences are recognized:
  92. (note that CSI = 'ESC [', and DCS = 'ESC P')
  93.  
  94. SEQUENCE        FUNCTION
  95.  
  96.  ESC [ <row> ; <col> H     Position cursor. Row and/or column may be omitted.
  97.  ESC [ <row> ; <col> f     same as previous.
  98.  
  99.  ESC [ <ext> J         Erase in screen. 'ext' values:
  100.                 0 = erase cursor to end of screen
  101.                 1 = erase start of screen to cursor
  102.                 2 = erase entire screen
  103.  
  104. All other CSI and DCS sequences are ignored. The next version will support
  105. many more but I am a little too burned out right now to add them for this
  106. version.
  107.  
  108.  
  109. --- MENU SELECTIONS:
  110.  
  111. THE 'STUFF' MENU:
  112.  
  113. "About Wtp.."
  114.      Just displays a little info 'bout me, Nothing fancy.
  115.  
  116. "load settings"
  117.      Presents a requester where you can enter the name of a Wtp settings
  118.      file created with the next menu item and Wtp will change the current
  119.      settings to match those in the file.  Note that if 'auto-dial' is
  120.      enabled Wtp will attempt to dial the phone number after the settings
  121.      are loaded. Future versions will provide a "Mac"ish scrolling window
  122.      of available settings files.
  123.  
  124. "save settings"
  125.      Presents a requester to specify the name of a file to which the
  126.      current settings will be written. Any name may be used but I suggest
  127.      that a ".wtp" be appended to it as future versions will auto-magically
  128.      display a list of all such files when 'loading' settings.
  129.  
  130. "quit"
  131.      Amazingly enough just quits "Wtp" and returns to the CLI. Will close
  132.      any open text capture or transmission files.
  133.  
  134.  
  135. THE 'FILE' MENU:    (file transfer)
  136.  
  137. "capture text to a file"
  138.      Allows you to open a new file to which all received characters will
  139.      be written.  Note that the "text transfer options" effect which
  140.      characters will be written to the file. Select this menu item again
  141.      to close the capture file.
  142.  
  143. "send a text file"
  144.      Allows you to open an existing file and send it out the serial port.
  145.      Which characters are sent depends on the text transfer options.
  146.      Selecting this item again will cancel the text file send.
  147.  
  148. "XMODEM (text) send"
  149.      Will transmit a text file using the XMODEM protocol. Note that the
  150.      "text transfer options" are applied to the data.  The bell is sounded
  151.      when the transfer has completed.  During the transfer the "File" menu
  152.      will contain an option which will allow canceling the transfer.
  153.      Current version does not support CRC transfers but this will be added.
  154.      Any unused space in the last XMODEM record will be filled with 0s.
  155.      Also note that all XMODEM transfers automatically force XON/XOFF
  156.      handshake off and 8 data bits.
  157.  
  158. "XMODEM (text) receive"
  159.      Receives a file using XMODEM protocol. Applies the "text transfer
  160.      options" to the received data. Note that the "strip control characters"
  161.      options will cause the extra 0s appended to the last record by the
  162.      XMODEM send function to be stripped.  Can be aborted via the "File"
  163.      menu.
  164.  
  165. "XMODEM (binary) send"
  166.      Send a file using XMODEM protocol. File data is transferred as is and
  167.      is not effected by the "text transfer options".
  168.  
  169. "XMODEM (binary) receive"
  170.      Receive a file using XMODEM protocol. Data is saved as received and
  171.      is not effected by the "text transfer options".
  172.  
  173.      I would like to add an Amiga specific XMODEM transfer option similar
  174.      to "MacBinary" and would like to here ideas as to what people would
  175.      like to see in it.
  176.  
  177. "Text transfer options..."
  178.      Allows changes several options which apply to text transfers:
  179.  
  180.      "LFs <--> CR/LFs"
  181.       When checked causes received CRs to be thrown away and appends
  182.       CRs before any LFs transmitted.
  183.  
  184.      "strip control chars"
  185.       Causes any control characters other than CR, LF and TAB to be
  186.       thrown away on both send and receive. This includes NULs (0)
  187.       and DELs (7F hex).
  188.  
  189.  
  190. THE 'PORT' MENU:    (serial port settings)
  191.  
  192. "Baud rate"
  193.      Submenu allows changing the current transmission speed. You probably
  194.      need XON/XOFF handshaking for the higher speeds (9600 & 19200).
  195.  
  196. "Character format"
  197.      Allows selection of the character size and parity mode. The default
  198.      setting is "8 data bits/no parity" which is the most common.
  199.  
  200. "Stop bits"
  201.      Can select 1 or 2 stop bits. Generally not important but provided
  202.      for completeness. Note that the serial port driver does not support
  203.      2 stop bits with 8 data bits but I allow its selection anyway. I
  204.      suspect you will actually get 1 stop bit.
  205.  
  206. "XON/XOFF handshake"
  207.      A common handshaking method which sends a CONTROL-S when the receiver
  208.      is falling behind and a CONTROL-Q when it has caught up. This option
  209.      applies to both sent and received data but does NOT apply to XMODEM
  210.      transfers as CONTROL-S and CONTROL-Q are valid data characters. You
  211.      can leave this option on in any case and XMODEM transfers internally
  212.      turn it off for the duration of the transfer.
  213.  
  214.  
  215. THE 'SCREEN' MENU:
  216.  
  217. "cursor wrap at EOL"
  218.      When checked causes the cursor to wrap to the next line when it hits
  219.      the right edge of the screen. Will also cause the cursor to wrap to
  220.      the previous line when you backspace past the left screen edge.
  221.      If this option is off the cursor will be pinned to the left and right
  222.      screen edges. I found that turning cursor wrap off on Delphi prevents
  223.      problems with lines of exactly 80 characters (the VT-100 treats column
  224.      80 specially so it does not have this problem.)
  225.  
  226. "local echo"
  227.      When checked causes all data entered at the keyboard (and also send
  228.      from a text file) to be displayed on the screen. This normally only
  229.      usefull for talking terminal to terminal as Delphi's or Compuserve's
  230.      computers normally handle the echoing of keys. The normal setting
  231.      for this option is OFF.
  232.  
  233. "Cursor style..."
  234.      Allows selection of either a box or underline cursor.  Unfortunately
  235.      the blinking cursor option is not implemented in this version but
  236.      will be in the next.
  237.  
  238. "Bell type..."
  239.      Selects which type of bell to use.
  240.      The 'visual' bell is the good ol' screen flash bell. The 'beep' bell
  241.      will be an audio tone but is not implemented in this version because
  242.      it is more trouble than it is worth. The (infamous) next version
  243.      will have this feature supported.  The 'speech' bell uses the
  244.      narrator device to provide spoken text for bell functions. Note
  245.      that the 'narrator.device' file must be present in the DEVS
  246.      directory to use this option.
  247.  
  248. "clear screen"
  249.      Clears the screen and homes the cursor. Provided as a convienience
  250.      feature.
  251.  
  252.  
  253. THE 'DIALING' MENU:
  254.  
  255. "(no title)"
  256.      This menu item displays the name you have assigned to the current
  257.      settings. Selecting this item allows you to change the name. If
  258.      a blank name is entered it is displayed as "(no title)". You can
  259.      use this to label the intended use for these settings like:
  260.      "Delphi via Uninet".
  261.  
  262. "(no number)"
  263.      This item displays the current phone number string. This string
  264.      will be send to the (HAYES compatible) modem during dialing and
  265.      should be the actual phone number.  If no phone number has been
  266.      specified this item is displayed as "(no number)" and dialing
  267.      functions are disabled.
  268.  
  269. "auto-dial when loaded"
  270.      If this item is checked in a setting file then Wtp will automatically
  271.      dial the current phone number whenever the file is loaded. This
  272.      option is disabled if no phone number has been specified.
  273.  
  274. "dial number now"
  275.      Initiates dialing of the current phone number. Will first hangup
  276.      the phone in case a call is already in progress and then will dial
  277.      the number. Assumes the presence of a HAYES compatible external
  278.      modem on the serial port. The dialing string consists of:
  279.  
  280.     "ATDT <phone number string>"<CR>
  281.  
  282. "hang up the phone"
  283.      Terminates the current phone call. Assumes a HAYES compatible
  284.      modem on the serial port. The sequence sent is:
  285.  
  286.     <pause 3 seconds>
  287.     "+++"
  288.     <pause 3 seconds>
  289.     "ATH"<CR>
  290.     <pause 1 second>
  291.  
  292.  
  293. --- THAT'S ALL FILK!
  294.  
  295.      Hopefully you have enough info to use and enjoy Wtp. If you have any
  296.      problems or suggestions for improvement just send me mail on Delphi
  297.      or Compuserve.  So long and lets make the Amiga the best machine
  298.      around!
  299.  
  300.      Dave Warker
  301.           Delphi:    DAVEWARKER
  302.       Compuserve:    70406,626
  303.